---
target: Umo Editor Server
keywords: Umo Editor Next,Umo Editor Server,Umo Editor后端,Umo Editor服务端
description: Umo Editor 是一个基于 Vue3 和 Tiptap 的本土化开源文档编辑器，专为国人用户设计。它提供了强大的文档编辑能力和 AI 创作功能，支持分页模式、Markdown 语法、富文本编辑、多种格式的节点插入、页面样式设置、文档导出与打印等功能。此外，Umo Editor 还支持自定义扩展、多语言设置和暗色主题。
---

# 接口列表

Umo Editor Server 通过 http 或 websocket 接口的形式，增强 Umo Editor Next 的能力，在开发环境下，您可以启动项目后，通过 http://127.0.0.1:1235/docs 访问 Swagger 文档。

目前提供的接口简要说明如下，更详细的信息请查看接口文档和代码注释。

## 检查服务状态

- `GET /`：返回服务是否正在运行的信息，如果无法访问该路由，则代表服务可能未启动或服务异常。

## Open API 接口文档
- `GET /docs`：接口文档，用于查看和测试接口，该接口在生产环境下不可用。

## 文档导入导出

- `POST /import/office`：将 Office 等格式的文档转换为 Umo Editor 所支持的格式，支持的格式包括：doc, docx, xls, xlsx, ppt, pptx, odp, odt, ods, rtf, wps, et, dps 等，并可自行扩展。
- `POST /export/pdf`：将文档导出为 PDF 格式。
- `POST /export/image/:type`：将文档导出为图片格式，支持 `jpeg`、`png`、`webp` 格式图片的导出。
- `POST /export/thumbnail`：导出文档缩略图（仅导出文档第一页内容）。

## AI 服务代理
- `GET | POST /ai/{provider}/{endpoint}`：根据 provider 和 endpoint 参数动态代理 GET 请求到不同的 AI 服务商（如 DeepSeek、OpenAI、Moonshot AI 等）。可根据需要进行扩展和修改。该接口的主要作用是将请求转发到指定的 AI 服务商，并返回响应结果。具体实现和使用方式请参考代码注释。

## 文档协作、批注

- `GET /provider`：WebSocket 接口，应通过 ws(s):// 协议连接，该接口的大部分内容是以二进制的形式存储和传输。其配置和相关说明等见源代码。

## 示例接口

- `GET /template`：模板列表，返回所有可用的模板信息。
- `GET /template/:id`：模板详情，返回指定 ID 的模板详情信息。
- `POST /template`：创建模板，根据请求体创建新的模板并返回模板详情信息。
- `PUT /template/:id`：更新模板，根据请求体更新指定 ID 的模板信息并返回更新后的模板详情信息。
- `DELETE /template/:id`：删除模板，根据指定 ID 删除模板并返回删除结果信息。

## 图标列表

- `GET /icons`：图标列表，返回所有可用的图标信息。

## 静态文件

返回 Umo Editor Next 的打包文件和 `@umoteam/editor-external` 等静态文件，例如：

- `GET /static`：返回 Umo Editor Next 的主 CSS 文件，可用于配置 Umo Editor Next 的 [`cdnUrl`](../editor/options/cdn) 配置项。
- `GET /static/next/7.1.0/style.css`：返回 Umo Editor Next 的样式文件，可用于配置 Umo Editor Next 的 [`export.styleURL`](../next/export) 配置项。
